Dropbox Library
Type
library
Description
Implements the Dropbox v2 API. Doesn't include business pro API.
Children Properties
Command
| Name | Summary | Syntax |
|---|---|---|
| dropboxUploadSessionStart | Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. | dropboxUploadSessionStart <pAccessToken>, <pData>, [<pCallback>] |
| dropboxGetFolderMetadata | Returns shared folder metadata by its folder ID. | dropboxGetFolderMetadata <pAccessToken>, <pSharedFolderId>, [<pActions>, <pCallback>] |
| dropboxCreateSharedLinkWithSettings | Create a shared link with custom settings | dropboxCreateSharedLinkWithSettings <pAccessToken>, <pPath>, [<pSettings>, <pCallback>] |
| dropboxMountFolder | The current user mounts the designated folder. | dropboxMountFolder <pAccessToken>, <pSharedFolderId>, [<pCallback>] |
| dropboxUnmountFolder | The current user unmounts the designated folder. | dropboxUnmountFolder <pAccessToken>, <pSharedFolderId>, [<pCallback>] |
| dropboxGetSpaceUsage | Get the space usage information for the current user's account. | dropboxGetSpaceUsage <pAccessToken>, [<pCallback>] |
| dropboxGetThumbnail | Get a thumbnail for an image. | dropboxGetThumbnail <pAccessToken>, <pPath>, <pFormat>, <pSize>, [<pCallback>] |
| dropboxGetPreview | Get a preview for a file. | dropboxGetPreview <pAccessToken>, <pPath>, [<pCallback>] |
| dropboxRestore | Restore a file to a specific revision. | dropboxRestore <pAccessToken>, <pPath>, <pRevision>, [<pCallback>] |
| dropboxSearch | Searches for files and folders. | dropboxSearch <pAccessToken>, <pPath>, <pQuery>, <pStart>, <pMaxResults>, <pMode>, [<pCallback>] |
| dropboxListRevisions | Return revisions of a file. | dropboxListRevisions <pAccessToken>, <pPath>, <pLimit>, [<pCallback>] |
| dropboxGetMetadata | Returns the metadata for a file or folder. | dropboxGetMetadata <pAccessToken>, <pPath>, <pIncludeMediaInfo>, [<pCallback>] |
| dropboxListFoldersContinue | Once a cursor has been retrieved from dropboxListFolders, use this to paginate through all shared folder members. | dropboxListFoldersContinue <pAccessToken>, <pCursor>, [<pCallback>] |
| dropboxGetAccount | Get information about a user's account. | dropboxGetAccount <pAccessToken>, <pUserAccountID>, [<pCallback>] |
| dropboxRelinquishFolderMembership | The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. | dropboxRelinquishFolderMembership <pAccessToken>, <pSharedFolderId>, <pLeaveACopy>, [<pCallback>] |
| dropboxUnshareFolder | Allows a shared folder owner to unshare the folder. | dropboxUnshareFolder <pAccessToken>, <pSharedFolderId>, <pLeaveACopy>, [<pCallback>] |
| dropboxUpdateFolderPolicy | Update the sharing policies for a shared folder. | dropboxUpdateFolderPolicy <pAccessToken>, <pSharedFolderId>, <pMemberPolicy>, <pAclUpdatePolicy>, <pSharedLinkPolicy>, [<pCallback>] |
| dropboxCheckJobStatus | Returns the status of an asynchronous job. | dropboxCheckJobStatus <pAccessToken>, <pAsyncJobId>, [<pCallback>] |
| dropboxUpload | Create a new file with the contents provided in the request. | dropboxUpload <pAccessToken>, <pPath>, <pMode>, <pAutorename>, <pMute>, <pData>, [<pCallback>] |
| dropboxListFolderMembers | Returns shared folder membership by its folder ID. | dropboxListFolderMembers <pAccessToken>, <pSharedFolderId>, [<pActions>, <pLimit>, <pCallback>] |
| dropboxListFolderMembersContinue | Once a cursor has been retrieved from dropboxListFolderMembers, use this to paginate through all shared folder members. | dropboxListFolderMembersContinue <pAccessToken>, <pCursor>, [<pCallback>] |
| dropboxCheckShareJobStatus | Returns the status of an asynchronous job for sharing a folder. | dropboxCheckShareJobStatus <pAccessToken>, <pAsyncJobId>, [<pCallback>] |
| dropboxListFolder | Starts returning the contents of a folder. | dropboxListFolder <pAccessToken>, <pPath>, <pRecursive>, <pIncludeMediaInfo>, [<pCallback>] |
| dropboxUploadSessionFinish | Finish an upload session and save the uploaded data to the given file path. | dropboxUploadSessionFinish <pAccessToken>, <pSession>, <pOffset>, <pPath>, <pMode>, <pAutorename>, <pMute>, <pData>, [<pCallback>] |
| dropboxRemoveFolderMember | Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member. | dropboxRemoveFolderMember <pAccessToken>, <pSharedFolderId>, <pMember>, <pLeaveACopy>, [<pCallback>] |
| dropboxRevokeSharedLink | Revoke a shared link. | dropboxRevokeSharedLink <pAccessToken>, <pURL>, [<pCallback>] |
| dropboxDownload | Download a file from a user's Dropbox. | dropboxDownload <pAccessToken>, <pPath>, [<pCallback>] |
| dropboxCopy | Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied. | dropboxCopy <pAccessToken>, <pPathFrom>, <pPathTo>, <pAllowSharedFolder>, <pAutoRename>, [<pCallback>] |
| dropboxCreateFolder | Create a folder at a given path. | dropboxCreateFolder <pAccessToken>, <pPath>, <pAutoRename>, [<pCallback>] |
| dropboxDelete | Delete the file or folder at a given path. | dropboxDelete <pAccessToken>, <pPath>, [<pCallback>] |
| dropboxGetAccountBatch | Get information about multiple user accounts. At most 300 accounts may be queried per request. | dropboxGetAccountBatch <pAccessToken>, <pUserAccountIDs>, [<pCallback>] |
| dropboxAddFolderMember | Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member. | dropboxAddFolderMember <pAccessToken>, <pSharedFolderId>, <pMembers>, <pQuiet>, <pCustomMessage>, [<pCallback>] |
| dropboxListFolders | Return the list of all shared folders the current user has access to. | dropboxListFolders <pAccessToken>, [<pActions>, <pLimit>, <pCallback>] |
| dropboxListSharedLinks | List shared links of this user. | dropboxListSharedLinks <pAccessToken>, [<pPath>, <pDirectOnly>, <pCursor>, <pCallback>] |
| dropboxModifySharedLinkSettings | Modify the shared link's settings. | dropboxModifySharedLinkSettings <pAccessToken>, <pUrl>, [<pSettings>, <pRemoveExpiration>, <pCallback>] |
| dropboxPermanentlyDelete | Permanently delete the file or folder at a given path. | dropboxPermanentlyDelete <pAccessToken>, <pPath>, [<pCallback>] |
| dropboxListMountableFolders | Return the list of all shared folders the current user can mount or unmount. | dropboxListMountableFolders <pAccessToken>, [<pActions>, <pLimit>, <pCallback>] |
| dropboxMove | Move a file or folder to a different location in the user's Dropbox. | dropboxMove <pAccessToken>, <pPathFrom>, <pPathTo>, <pAllowSharedFolder>, <pAutoRename>, [<pCallback>] |
| dropboxListFolderLongPoll | A longpoll endpoint to wait for changes on an account. | dropboxListFolderLongPoll <pCursor>, <pTimeout>, [<pCallback>] |
| dropboxGetSharedLinkFile | Download the shared link's file from a user's Dropbox. | dropboxGetSharedLinkFile <pAccessToken>, <pUrl>, [<pPath>, <pLinkPassword>, <pCallback>] |
| dropboxUpdateFolderMember | Allows an owner or editor of a shared folder to update another member's permissions. | dropboxUpdateFolderMember <pAccessToken>, <pSharedFolderId>, <pMember>, <pAccessLevel>, [<pCallback>] |
| dropboxGetSharedLinkMetadata | Get the shared link's metadata. | dropboxGetSharedLinkMetadata <pAccessToken>, <pUrl>, [<pPath>, <pLinkPassword>, <pCallback>] |
| dropboxListFolderContinue | Once a cursor has been retrieved from list_folder, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for list folder. | dropboxListFolderContinue <pAccessToken>, <pCursor>, [<pCallback>] |
| dropboxShareFolder | Share a folder with collaborators. | dropboxShareFolder <pAccessToken>, <pPath>, <pMemberPolicy>, <pAclUpdatePolicy>, <pSharedLinkPolicy>, <pForceAsync>, [<pCallback>] |
| dropboxTransferFolder | Transfer ownership of a shared folder to a member of the shared folder. | dropboxTransferFolder <pAccessToken>, <pSharedFolderId>, <pToDropboxId>, [<pCallback>] |
| dropboxGetCurrentAccount | Get information about the current user's account. | dropboxGetCurrentAccount <pAccessToken>, [<pCallback>] |
| dropboxListMountableFoldersContinue | Once a cursor has been retrieved from dropboxListMountableFolders, use this to paginate through all shared folder members. | dropboxListMountableFoldersContinue <pAccessToken>, <pCursor>, [<pCallback>] |
| dropboxUploadSessionAppend | Append more data to an upload session. | dropboxUploadSessionAppend <pAccessToken>, <pSession>, <pOffset>, <pData>, [<pCallback>] |
| dropboxListFolderGetLatestCursor | A way to get a cursor for the folder's state. | dropboxListFolderGetLatestCursor <pAccessToken>, <pPath>, <pRecursive>, <pIncludeMediaInfo>, [<pCallback>] |